=============
Work versions
=============

You can use work versions to increment your work on assets. 

.. note::
  You should use work versions to increment your scenes only when it is needed. Prefer a simple save in the softwares when you are doing small changes and incremental save with wizard when you modify enough to need a backup.

-----------------------
View your work versions
-----------------------

Go to the work versions tab.

.. image:: _images/work_versions_tab.jpg
  :width: 1200
  :alt: Alternative text

.. note::
  You can modify the display of the work versions by clicking on this |icon_view| button in the work versions tab.

  .. image:: _images/switch_icon_view.gif
    :width: 1200
    :alt: Alternative text

.. |icon_view| image:: _images/icon_view.png
  :width: 30
  :alt: Alternative text

------------------------------------
Save a work version within softwares
------------------------------------

When you launch a software with wizard ( See :ref:`Launch a work version` ), a wizard menu appears in the menu bar of the software.

To save a new work version, click on |save| Save, a popup will appear, you can use it to add a comment to your work version.

.. image:: _images/save_and_comment.gif
  :width: 1200
  :alt: Alternative text

.. |save| image:: _images/save.png
  :width: 30
  :alt: Alternative text

Here are the menus in softwares :

.. tab:: Maya

  .. image:: _images/maya_wizard_menu.jpg
    :width: 1200
    :alt: Alternative text

.. tab:: Blender

  .. image:: _images/blender_wizard_menu.jpg
    :width: 1200
    :alt: Alternative text

.. tab:: Guerilla Render

  .. image:: _images/guerilla_render_wizard_menu.jpg
    :width: 1200
    :alt: Alternative text

.. tab:: Substance Painter

  .. image:: _images/substance_painter_wizard_menu.jpg
    :width: 1200
    :alt: Alternative text

.. tab:: Houdini

  .. image:: _images/houdini_wizard_menu.jpg
    :width: 1200
    :alt: Alternative text

.. tab:: Nuke

  .. image:: _images/nuke_wizard_menu.jpg
    :width: 1200
    :alt: Alternative text

-------------------------------
Create a new empty work version
-------------------------------

In the work versions tab, click on the |create_empty_version| button or Right click > Create new empty version.
This will create a new version without a file, when you will launch that version, this will be a fresh scene.

.. |create_empty_version| image:: _images/create_empty_version.png
  :width: 30
  :alt: Alternative text

------------------------
Duplicate a work version
------------------------

Select the work version you want to duplicate and click on the |duplicate_work_version| button or Right click > Duplicate version(s)

.. |duplicate_work_version| image:: _images/duplicate_work_version.png
  :width: 30
  :alt: Alternative text

---------------------------
Copy / Paste a work version
---------------------------

You can copy a work version from a work environment and paste it in another work environment.
Right click on the version you want to copy and select > `Copy work version to clipboard`

.. image:: _images/copy_work_version.jpg
  :width: 1200
  :alt: Alternative text

Then you can paste it on the desired work environment. Right click anywhere in the work versions tab and select > `Paste work version from clipboard` or `Paste work version from clipboard and mirror references`

.. image:: _images/paste_work_version.jpg
  :width: 1200
  :alt: Alternative text

.. warning::
  Pasting with the mirror references option will override the current work environment references.

-------------------------------
Manually merge an external file
-------------------------------

On the work versions tab, click on the |merge_work_version| button, drag and drop a the file you want to merge or Right click > Manually merge a file.

.. |merge_work_version| image:: _images/merge_work_version.png
  :width: 30
  :alt: Alternative text

.. image:: _images/drag_and_drop_version.gif
  :width: 1200
  :alt: Alternative text

------------------------------------
Modify the comment of a work version
------------------------------------

In the work versions tab, select the version that you want to edit and Right click > Modify comment or click on the |edit_comment| button.

.. |edit_comment| image:: _images/edit_comment.png
  :width: 30
  :alt: Alternative text

.. image:: _images/modify_version_comment.gif
  :width: 1200
  :alt: Alternative text

-----------------------
View the versions files
-----------------------

In the work versions tab, click on the |open_folder| button or Right click > Open folder.

.. |open_folder| image:: _images/open_folder.png
  :width: 30
  :alt: Alternative text

----------------------
Archive a work version
----------------------

Go to the :ref:`Archive a work version` section.